Vcenter TrustedInfrastructure TrustAuthorityClusters ConsumerPrincipals Info

This schema is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The Vcenter TrustedInfrastructure TrustAuthorityClusters ConsumerPrincipals Info schema contains the information necessary to establish trust between a workload vCenter and a Trust Authority Host.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "id": "string",
    "principal": {
        "id": {
            "name": "string",
            "domain": "string"
        },
        "type": "string"
    },
    "issuer_alias": "string",
    "issuer": "string",
    "certificates": [
        {
            "cert_chain": [
                "string"
            ]
        }
    ],
    "health": "string",
    "message": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    }
}

string

Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The unqiue identifier of a connection profile.

This property was added in vSphere API 7.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.

principal

Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The principal used by the vCenter to retrieve tokens. Currently this is the vCenter solution user.

This property was added in vSphere API 7.0.0.0.

string

issuer_alias

Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

A user-friendly alias of the service which created and signed the security token.

This property was added in vSphere API 7.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.authentication.trust.security-token-issuer. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.authentication.trust.security-token-issuer.

string

issuer

Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The service which created and signed the security token.

This property was added in vSphere API 7.0.0.0.

array of Vcenter TrustedInfrastructure X509CertChain

certificates

Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The certificates used by the vCenter STS to sign tokens.

This property was added in vSphere API 7.0.0.0.

string

health

Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

The consistency of the profile across the hosts in the cluster.

For more information see: Vcenter TrustedInfrastructure TrustAuthorityClusters ConsumerPrincipals Health.

This property was added in vSphere API 7.0.0.0.

message

Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

A localizable message describing the health of the profile.

This property was added in vSphere API 7.0.0.0.

If missing or null, the certificates won't be updated.

Deprecated